/*
 * @(#) $Header$
 *
 * Copyright (C) 2006  Daniel Léonard
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package ca.forklabs.baselib.awt.datatransfer;

import java.awt.Toolkit;
import java.awt.datatransfer.Clipboard;
import java.awt.datatransfer.ClipboardOwner;
import java.awt.datatransfer.StringSelection;
import java.awt.datatransfer.Transferable;

/**
 * Class {@code FileUtil} provides utility classes to make it easier to interact
 * with the system clipboard.
 *
 * @author   <a href="mailto:forklabs at gmail.com?subject=ca.forklabs.baselib.awt.datatransfer.ClipboardUtil">Daniel Léonard</a>
 * @version $Revision$
 */
public class ClipboardUtil {

//---------------------------
// Constructors
//---------------------------

   /**
    * Constructor.
    */
   protected ClipboardUtil() {
   // nothing
      }


//---------------------------
// Class methods
//---------------------------

   /**
    * Gets the system clipboard.
    * @return   the system clipboard.
    */
   public static Clipboard getClipboard() {
      Toolkit toolkit = Toolkit.getDefaultToolkit();
      Clipboard clipboard = toolkit.getSystemClipboard();
      return clipboard;
      }

   /**
    * Puts the text into the system clipboard.
    * @param   text   the text.
    */
   public static void putInClipboard(String text) {
      ClipboardOwner owner = null;
      putInClipboard(text, owner);
      }

   /**
    * Puts the text into the system clipboard.
    * @param   text   the text.
    * @param   owner   the clipboard owner.
    */
   public static void putInClipboard(String text, ClipboardOwner owner) {
      Clipboard clipboard = getClipboard();
      Transferable content = new StringSelection(text);
      clipboard.setContents(content, owner);
      }

   }
